Investigator API
POST Search RateDirectory
Overview
OperationId: POST Search RateDirectory
Authorization Method(s): OAuth
Verb: POST
End Point: /api/ratedirectory/search
Example Request
The following is an json request for this operation.
{
"filters": {
"releaseNumber": null,
"dateType": "Date"
},
"parameters": {
"geocode": null,
"locations": [],
"postalCode": null,
"npanxx": null,
"stateCountyCity": null,
"state": null,
"asOfDate": {
"year": "2025",
"month": "02",
"day": 1
},
"address": {
"address1": "",
"address2": "",
"city": "",
"county": "",
"postalCode": "",
"plus4": "",
"state": ""
},
"currentPage": 0,
"pageSize": 0
},
"clientNumber": "${Client Number}",
"searchCountry": "UnitedStates",
"searchOption": "Location",
"searchType": "RateDirectory"
}Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Api-version* | api-version | undefined |
Overview
Example Response
The following is an example response you can expect for this operation
{
"results": [
{
"locationID": "",
"state": "",
"county": "",
"city": "",
"local": "",
"postalCode": "",
"plus4": "",
"sales_Use": "",
"federal_TaxRate": 0,
"state_TaxRate": 0,
"county_TaxRate": 0,
"city_TaxRate": 0,
"local_TaxRate": 0,
"effectiveDate": "2025-03-12T13:54:43.8763953-06:00",
"total_TaxRate": 2,
"totalPages": 1
}
],
"locationResults": [
{
"locationId": "",
"results": [
{
"locationID": "",
"state": "",
"county": "",
"city": "",
"local": "",
"postalCode": "",
"plus4": "",
"sales_Use": "",
"federal_TaxRate": 0,
"state_TaxRate": 0,
"county_TaxRate": 0,
"city_TaxRate": 0,
"local_TaxRate": 0,
"effectiveDate": "2025-03-12T13:54:43.8764012-06:00",
"total_TaxRate": 2,
"totalPages": 1
}
]
}
],
"errors": []
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | RateDirectory search results were successfully returned. |
| 401 | Use doesn't have access to use this API. |
| 404 | Not Found |